<!DOCTYPE html>
<html lang="en">
  <head>
    <title>OSLogTypeTranslator Enum Reference</title>
    <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    <meta charset='utf-8'>
    <script src="../js/jquery.min.js" defer></script>
    <script src="../js/jazzy.js" defer></script>
    
  </head>
  <body>
    <a name="//apple_ref/swift/Enum/OSLogTypeTranslator" class="dashAnchor"></a>
    <a title="OSLogTypeTranslator Enum Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="../index.html">CleanroomLogger Docs</a> (100% documented)</p>
        <p class="header-right"><a href="https://github.com/emaloney/CleanroomLogger"><img src="../img/gh.png"/>View on GitHub</a></p>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="../index.html">CleanroomLogger Reference</a>
        <img id="carat" src="../img/carat.png" />
        OSLogTypeTranslator Enum Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="../Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Classes/BasicLogConfiguration.html">BasicLogConfiguration</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/BufferedLogEntryMessageRecorder.html">BufferedLogEntryMessageRecorder</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/BufferedLogEntryRecorder.html">BufferedLogEntryRecorder</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/BufferedLogRecorder.html">BufferedLogRecorder</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/BufferedMessageRecorder.html">BufferedMessageRecorder</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ConcatenatingLogFormatter.html">ConcatenatingLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ConsoleLogConfiguration.html">ConsoleLogConfiguration</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ConsoleLogConfiguration/StandardStreamsMode.html">– StandardStreamsMode</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/FieldBasedLogFormatter.html">FieldBasedLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/FieldBasedLogFormatter/Field.html">– Field</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/FileLogRecorder.html">FileLogRecorder</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/LogReceptacle.html">LogReceptacle</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/LogRecorderBase.html">LogRecorderBase</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/OutputStreamLogRecorder.html">OutputStreamLogRecorder</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ParsableLogFormatter.html">ParsableLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/ReadableLogFormatter.html">ReadableLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/RotatingLogFileConfiguration.html">RotatingLogFileConfiguration</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/RotatingLogFileRecorder.html">RotatingLogFileRecorder</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/StandardErrorLogRecorder.html">StandardErrorLogRecorder</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/StandardLogFormatter.html">StandardLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/StandardOutputLogRecorder.html">StandardOutputLogRecorder</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/StandardStreamsLogRecorder.html">StandardStreamsLogRecorder</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/XcodeLogConfiguration.html">XcodeLogConfiguration</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/XcodeLogFormatter.html">XcodeLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/XcodeTraceLogFormatter.html">XcodeTraceLogFormatter</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Enums.html">Enums</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Enums/CallingThreadStyle.html">CallingThreadStyle</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/DelimiterStyle.html">DelimiterStyle</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/LogSeverity.html">LogSeverity</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/OSLogTypeTranslator.html">OSLogTypeTranslator</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/SeverityStyle.html">SeverityStyle</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/SeverityStyle/TextRepresentation.html">– TextRepresentation</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/TimestampStyle.html">TimestampStyle</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Protocols/LogConfiguration.html">LogConfiguration</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/LogFilter.html">LogFilter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/LogFormatter.html">LogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/LogRecorder.html">LogRecorder</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Structs.html">Structs</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Structs/CallSiteLogFormatter.html">CallSiteLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/CallingThreadLogFormatter.html">CallingThreadLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/DelimiterLogFormatter.html">DelimiterLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/LiteralLogFormatter.html">LiteralLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/Log.html">Log</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/LogChannel.html">LogChannel</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/LogEntry.html">LogEntry</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/LogEntry/Payload.html">– Payload</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/LogSeverityFilter.html">LogSeverityFilter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/OSLogRecorder.html">OSLogRecorder</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PayloadLogFormatter.html">PayloadLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PayloadMessageLogFormatter.html">PayloadMessageLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PayloadTraceLogFormatter.html">PayloadTraceLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PayloadValueLogFormatter.html">PayloadValueLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/ProcessIDLogFormatter.html">ProcessIDLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/ProcessNameLogFormatter.html">ProcessNameLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/SeverityLogFormatter.html">SeverityLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/StackFrameLogFormatter.html">StackFrameLogFormatter</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/TimestampLogFormatter.html">TimestampLogFormatter</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            <h1>OSLogTypeTranslator</h1>
              <div class="declaration">
                <div class="language">
                  <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">OSLogTypeTranslator</span></code></pre>

                </div>
              </div>
            <p>Specifies the manner in which an <code>OSLogType</code> is selected to represent a
given <code><a href="../Structs/LogEntry.html">LogEntry</a></code>.</p>

<p>When a log entry is being recorded by an <code><a href="../Structs/OSLogRecorder.html">OSLogRecorder</a></code>, an <code>OSLogType</code>
value is used to specify the importance of the message; it is similar in
concept to the <code><a href="../Enums/LogSeverity.html">LogSeverity</a></code>.</p>

<p>Because there is not an exact one-to-one mapping between <code>OSLogType</code> and
<code><a href="../Enums/LogSeverity.html">LogSeverity</a></code> values, <code>OSLogTypeTranslation</code> provides a mechanism for 
deriving the appropriate <code>OSLogType</code> for a given <code><a href="../Structs/LogEntry.html">LogEntry</a></code>.</p>

          </section>
          <section class="section task-group-section">
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:15CleanroomLogger19OSLogTypeTranslatorO7defaultA2CmF"></a>
                    <a name="//apple_ref/swift/Element/default" class="dashAnchor"></a>
                    <a class="token" href="#/s:15CleanroomLogger19OSLogTypeTranslatorO7defaultA2CmF">default</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>The most direct translation from a <code><a href="../Structs/LogEntry.html">LogEntry</a></code>&lsquo;s <code>severity</code> to the
 corresponding <code>OSLogType</code> value.</p>

<p>This value strikes a sensible balance between the higher-overhead logging
 provided by <code><a href="../Enums/OSLogTypeTranslator.html#/s:15CleanroomLogger19OSLogTypeTranslatorO6strictA2CmF">.strict</a></code> and the more ephemeral logging of <code><a href="../Enums/OSLogTypeTranslator.html#/s:15CleanroomLogger19OSLogTypeTranslatorO7relaxedA2CmF">.relaxed</a></code>.</p>

<table><thead>
<tr>
<th>LogSeverity</th>
<th>OSLogType</th>
</tr>
</thead><tbody>
<tr>
<td><code>.verbose</code></td>
<td><code>.debug</code></td>
</tr>
<tr>
<td><code>.debug</code></td>
<td><code>.debug</code></td>
</tr>
<tr>
<td><code>.info</code></td>
<td><code>.info</code></td>
</tr>
<tr>
<td><code>.warning</code></td>
<td><code>.default</code></td>
</tr>
<tr>
<td><code>.error</code></td>
<td><code>.error</code></td>
</tr>
</tbody></table>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="k">case</span> <span class="err">`</span><span class="k">default</span><span class="err">`</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:15CleanroomLogger19OSLogTypeTranslatorO6strictA2CmF"></a>
                    <a name="//apple_ref/swift/Element/strict" class="dashAnchor"></a>
                    <a class="token" href="#/s:15CleanroomLogger19OSLogTypeTranslatorO6strictA2CmF">strict</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>A strict translation from a <code><a href="../Structs/LogEntry.html">LogEntry</a></code>&lsquo;s <code>severity</code> to an
 <code>OSLogType</code> value. Warnings are treated as errors; errors are
 treated as faults.</p>

<p>This will result in additional logging overhead being recorded by OSLog,
 and is not recommended unless you have a specific need for this.</p>

<table><thead>
<tr>
<th>LogSeverity</th>
<th>OSLogType</th>
</tr>
</thead><tbody>
<tr>
<td><code>.verbose</code></td>
<td><code>.debug</code></td>
</tr>
<tr>
<td><code>.debug</code></td>
<td><code>.debug</code></td>
</tr>
<tr>
<td><code>.info</code></td>
<td><code><a href="../Enums/OSLogTypeTranslator.html#/s:15CleanroomLogger19OSLogTypeTranslatorO7defaultA2CmF">.default</a></code></td>
</tr>
<tr>
<td><code>.warning</code></td>
<td><code>.error</code></td>
</tr>
<tr>
<td><code>.error</code></td>
<td><code>.fault</code></td>
</tr>
</tbody></table>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="k">case</span> <span class="n">strict</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:15CleanroomLogger19OSLogTypeTranslatorO7relaxedA2CmF"></a>
                    <a name="//apple_ref/swift/Element/relaxed" class="dashAnchor"></a>
                    <a class="token" href="#/s:15CleanroomLogger19OSLogTypeTranslatorO7relaxedA2CmF">relaxed</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>A relaxed translation from a <code><a href="../Structs/LogEntry.html">LogEntry</a></code>&lsquo;s <code>severity</code> to an
 <code>OSLogType</code> value. Nothing is treated as an error.</p>

<p>This results in low-overhead logging, but log entries are more
 ephemeral and may not contain as much OSLog metadata.</p>

<table><thead>
<tr>
<th>LogSeverity</th>
<th>OSLogType</th>
</tr>
</thead><tbody>
<tr>
<td><code>.verbose</code></td>
<td><code>.debug</code></td>
</tr>
<tr>
<td><code>.debug</code></td>
<td><code>.debug</code></td>
</tr>
<tr>
<td><code>.info</code></td>
<td><code>.info</code></td>
</tr>
<tr>
<td><code>.warning</code></td>
<td><code><a href="../Enums/OSLogTypeTranslator.html#/s:15CleanroomLogger19OSLogTypeTranslatorO7defaultA2CmF">.default</a></code></td>
</tr>
<tr>
<td><code>.error</code></td>
<td><code><a href="../Enums/OSLogTypeTranslator.html#/s:15CleanroomLogger19OSLogTypeTranslatorO7defaultA2CmF">.default</a></code></td>
</tr>
</tbody></table>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="k">case</span> <span class="n">relaxed</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:15CleanroomLogger19OSLogTypeTranslatorO12allAsDefaultA2CmF"></a>
                    <a name="//apple_ref/swift/Element/allAsDefault" class="dashAnchor"></a>
                    <a class="token" href="#/s:15CleanroomLogger19OSLogTypeTranslatorO12allAsDefaultA2CmF">allAsDefault</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p><code>OSLogType.default</code> is used for all messages.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="k">case</span> <span class="n">allAsDefault</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:15CleanroomLogger19OSLogTypeTranslatorO9allAsInfoA2CmF"></a>
                    <a name="//apple_ref/swift/Element/allAsInfo" class="dashAnchor"></a>
                    <a class="token" href="#/s:15CleanroomLogger19OSLogTypeTranslatorO9allAsInfoA2CmF">allAsInfo</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p><code>OSLogType.info</code> is used for all messages.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="k">case</span> <span class="n">allAsInfo</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:15CleanroomLogger19OSLogTypeTranslatorO10allAsDebugA2CmF"></a>
                    <a name="//apple_ref/swift/Element/allAsDebug" class="dashAnchor"></a>
                    <a class="token" href="#/s:15CleanroomLogger19OSLogTypeTranslatorO10allAsDebugA2CmF">allAsDebug</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p><code>OSLogType.debug</code> is used for all messages.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="k">case</span> <span class="n">allAsDebug</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:15CleanroomLogger19OSLogTypeTranslatorO8functionACSC0cD0VAA8LogEntryVccACmF"></a>
                    <a name="//apple_ref/swift/Element/function" class="dashAnchor"></a>
                    <a class="token" href="#/s:15CleanroomLogger19OSLogTypeTranslatorO8functionACSC0cD0VAA8LogEntryVccACmF">function</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Uses a custom function to determine the <code>OSLogType</code> to use for each
 <code><a href="../Structs/LogEntry.html">LogEntry</a></code>.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="k">case</span> <span class="nf">function</span><span class="p">((</span><span class="kt"><a href="../Structs/LogEntry.html">LogEntry</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">OSLogType</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </section>
        </section>
        <section id="footer">
          <p>© 2015-2017 <a class="link" href="http://tech.gilt.com/" target="_blank" rel="external">Gilt Groupe</a></p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</div>
</html>
